/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is ThumbsDown.
 *
 * The Initial Developer of the Original Code is Atte Kemppilä.
 * Portions created by the Initial Developer are Copyright (C) 2012
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */


const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Cu = Components.utils;

Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/XPCOMUtils.jsm");

Cu.import("resource://thumbsdown/ThumbsDown.jsm");
Cu.import("resource://thumbsdown/util.jsm");

const SCHEME = ThumbsDown.SCHEME;


/**
 * ThumbsDown "protocol" handler.
 * ThumbsDown urls are basically script install triggers.
 * See ThumbsDownService (components/service.js) for more info.
 */
function ThumbsDownProtocol()
{
    // empty
}

ThumbsDownProtocol.prototype =
{
    classID: Components.ID("{ad6a0188-0af2-11e2-8b5c-20cf30ccb8fb}"),
    
    contractID: "@mozilla.org/network/protocol;1?name=" + SCHEME,
    classDescription: "ThumbsDown protocol handler",
    
    QueryInterface: XPCOMUtils.generateQI([Ci.nsIProtocolHandler]),
    
    // nsIProtocolHandler
    
    scheme: SCHEME,
    
    defaultPort: -1,
    
    // no idea if these flags make sense
    protocolFlags:
        Ci.nsIProtocolHandler.URI_DOES_NOT_RETURN_DATA |
        Ci.nsIProtocolHandler.URI_INHERITS_SECURITY_CONTEXT |
        Ci.nsIProtocolHandler.URI_LOADABLE_BY_ANYONE |
        Ci.nsIProtocolHandler.URI_NOAUTH |
        Ci.nsIProtocolHandler.URI_NON_PERSISTABLE |
        Ci.nsIProtocolHandler.URI_NORELATIVE,
    
    allowPort: function(port, scheme)
    {
        return false;
    },
    
    newURI: function(spec, originCharset, baseUri)
    {
        let uri = Cc["@mozilla.org/network/simple-uri;1"].createInstance(Ci.nsIURI);
        uri.spec = spec;
        return uri;
    },

    newChannel: function(uri)
    {
        // newChannel() is never called because content policy (components/service.js)
        // rejects all thumbsdown protocol requests.
        // But if newChannel were to be called,
        // it's seems that it's "safe" to return false, but not null.
        return false;
    },
}


const NSGetFactory = XPCOMUtils.generateNSGetFactory([ThumbsDownProtocol]);
